GetTemplateSummary
Description
call the GetTemplateSummary interface to obtain information about a new template or an existing template.
Request Method
POST
Request Path
/apsara/route/ROS/GetTemplateSummary
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
TemplateURL | BODY | string | No | oss://ros/template/demo | the location of the file containing the template body. The URL must point to the template located in the Web server (HTTP or HTTPS) or Aliyun OSS bucket (for example, oss:// ros/template/demo, oss:// ros/template/demo?RegionId = cn-hangzhou), the maximum template is 524 and 288 bytes. If the OSS region is not specified, the default is the same as the interface parameter RegionId. description you must specify TemplateBody or TemplateURL parameters, but not at the same time. the maximum length of the URL is: 1024 bytes. |
ChangeSetId | BODY | string | No | 1f6521a4-05af-4975-afe9-bc4b45ad**** | change set ID. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
TemplateBody | BODY | string | No | {"ROSTemplateFormatVersion":"2015-09-01"} | the structure of the template. The length is 1~524 and 288 bytes. /p> p data-tag = "p" class = "p"> if the length is large, it is recommended to pass the parameters in the request body through HTTP POST + Body Param to avoid the request failure caused by the URL being too long. description you must specify the parameter TemplateBody or TemplateURL, but not at the same time. |
RegionId | BODY | string | No | cn-hangzhou | the region ID of the resource stack to which the template belongs. |
version | BODY | string | No | 2016-01-01 | version of api |
TemplateId | BODY | string | No | 5ecd1e10-b0e9-4389-a565-e4c15efc**** | template ID. |
StackId | BODY | string | No | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** | resource stack ID. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}